Template

interface Template

Represents a predefined layout structure or design that can be populated with dynamic content within the RevelDigital player system.

A Template typically defines a set of regions or zones, each with its own properties (like size, position, and associated content type or source). This allows for complex screen layouts where different pieces of information or media can be displayed simultaneously in a structured manner.

For example, a template might define a main content area, a sidebar for news feeds, and a footer for a ticker. Playlists or individual content sources can then be assigned to these specific zones within the template.

This interface currently provides methods to access the template's identifier (getId) and its user-defined name (getName). Further details about the template's structure (e.g., its zones and their properties) would typically be obtained through other means or related APIs if this interface is primarily for identification and basic metadata.

See also

// Example: How a Template might be associated with a Schedule

// Example: A playlist type that might utilize templates

// Example: If a RevelControl can be directly based on a Template

Functions

Link copied to clipboard
abstract fun getBackColor(): String
Gets the default background color for the template.
Link copied to clipboard
Gets a textual description of the template.
Link copied to clipboard
abstract fun getHeight(): Int
Gets the design height of this template in pixels.
Link copied to clipboard
abstract fun getId(): Int
Gets the unique identifier for this template.
Link copied to clipboard
abstract fun getModules(): Iterator<out RevelControl>
Gets an iterator over the modules or content elements that are part of this template's structure.
Link copied to clipboard
abstract fun getName(): String
Gets the user-defined name of this template.
Link copied to clipboard
Gets the recommended or designed orientation for this template.
Link copied to clipboard
abstract fun getScript(): String
Gets any associated script or programmatic logic for this template.
Link copied to clipboard
abstract fun getWidth(): Int
Gets the design width of this template in pixels.
Link copied to clipboard
abstract fun start()
Starts the template, making it active and visible.
Link copied to clipboard
abstract fun stop()
Stops the template, typically hiding it or pausing its activity.
abstract fun stop(callback: Runnable)
Stops the template and invokes a callback after any fade-out animations or transitions complete.